/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version
 * 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for
 * the specific language governing permissions and limitations under the License.
 */

package jmine.tec.test.junit.runner.formatter;

import java.io.BufferedWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.StringWriter;
import java.text.NumberFormat;
import java.util.Hashtable;

import jmine.tec.test.junit.runner.ConsoleTestRunner;
import jmine.tec.test.junit.runner.JUnitTest;
import jmine.tec.test.junit.runner.JUnitVersionHelper;
import junit.framework.AssertionFailedError;
import junit.framework.Test;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.util.FileUtils;
import org.apache.tools.ant.util.StringUtils;

/**
 * Prints plain text output of the test to a specified Writer.
 */

public class PlainJUnitResultFormatter implements JUnitResultFormatter {

    private static final double ONE_SECOND = 1000.0;

    /**
     * Formatter for timings.
     */
    private NumberFormat nf = NumberFormat.getInstance();

    /**
     * Timing helper.
     */
    private Hashtable<Test, Long> testStarts = new Hashtable<Test, Long>();

    /**
     * Where to write the log to.
     */
    private OutputStream out;

    /**
     * Helper to store intermediate output.
     */
    private StringWriter inner;

    /**
     * Convenience layer on top of {@link #inner inner}.
     */
    private BufferedWriter wri;

    /**
     * Suppress endTest if testcase failed.
     */
    private Hashtable<Test, Boolean> failed = new Hashtable<Test, Boolean>();

    private String systemOutput = null;

    private String systemError = null;

    /** No arg constructor */
    public PlainJUnitResultFormatter() {
        this.inner = new StringWriter();
        this.wri = new BufferedWriter(this.inner);
    }

    /** {@inheritDoc}. */
    public void setOutput(OutputStream output) {
        this.out = output;
    }

    /** {@inheritDoc}. */
    public void setSystemOutput(String systemOutput) {
        this.systemOutput = systemOutput;
    }

    /** {@inheritDoc}. */
    public void setSystemError(String err) {
        this.systemError = err;
    }

    /**
     * The whole testsuite started.
     * 
     * @param suite the test suite
     */
    public void startTestSuite(JUnitTest suite) {
        if (this.out == null) {
            return; // Quick return - no output do nothing.
        }
        StringBuffer sb = new StringBuffer("Testsuite: ");
        sb.append(suite.getName());
        sb.append(StringUtils.LINE_SEP);
        try {
            this.out.write(sb.toString().getBytes());
            this.out.flush();
        } catch (IOException ex) {
            throw new BuildException("Unable to write output", ex);
        }
    }

    /**
     * The whole testsuite ended.
     * 
     * @param suite the test suite
     */
    public void endTestSuite(JUnitTest suite) {
        StringBuffer sb = new StringBuffer("Tests run: ");
        sb.append(suite.runCount());
        sb.append(", Failures: ");
        sb.append(suite.failureCount());
        sb.append(", Errors: ");
        sb.append(suite.errorCount());
        sb.append(", Time elapsed: ");
        sb.append(this.nf.format(suite.getRunTime() / ONE_SECOND));
        sb.append(" sec");
        sb.append(StringUtils.LINE_SEP);

        // append the err and output streams to the log
        if (this.systemOutput != null && this.systemOutput.length() > 0) {
            sb.append("------------- Standard Output ---------------").append(StringUtils.LINE_SEP).append(this.systemOutput)
                    .append("------------- ---------------- ---------------").append(StringUtils.LINE_SEP);
        }

        if (this.systemError != null && this.systemError.length() > 0) {
            sb.append("------------- Standard Error -----------------").append(StringUtils.LINE_SEP).append(this.systemError)
                    .append("------------- ---------------- ---------------").append(StringUtils.LINE_SEP);
        }

        sb.append(StringUtils.LINE_SEP);

        if (this.out != null) {
            try {
                this.out.write(sb.toString().getBytes());
                this.wri.close();
                this.out.write(this.inner.toString().getBytes());
                this.out.flush();
            } catch (IOException ioex) {
                throw new BuildException("Unable to write output", ioex);
            } finally {
                if (this.out != System.out && this.out != System.err) {
                    FileUtils.close(this.out);
                }
            }
        }
    }

    /**
     * Interface TestListener.
     * <p>
     * A new Test is started.
     * 
     * @param t the test.
     */
    public void startTest(Test t) {
        this.testStarts.put(t, new Long(System.currentTimeMillis()));
        this.failed.put(t, Boolean.FALSE);
    }

    /**
     * Interface TestListener.
     * <p>
     * A Test is finished.
     * 
     * @param test the test.
     */
    public void endTest(Test test) {
        if (Boolean.TRUE.equals(this.failed.get(test))) {
            return;
        }
        synchronized (this.wri) {
            try {
                this.wri.write("Testcase: " + JUnitVersionHelper.getTestCaseName(test));
                Long l = (Long) this.testStarts.get(test);
                double seconds = 0;
                // can be null if an error occurred in setUp
                if (l != null) {
                    seconds = (System.currentTimeMillis() - l.longValue()) / ONE_SECOND;
                }

                this.wri.write(" took " + this.nf.format(seconds) + " sec");
                this.wri.newLine();
            } catch (IOException ex) {
                throw new BuildException(ex);
            }
        }
    }

    /**
     * Interface TestListener for JUnit &lt;= 3.4.
     * <p>
     * A Test failed.
     * 
     * @param test the test.
     * @param t the exception.
     */
    public void addFailure(Test test, Throwable t) {
        this.formatError("\tFAILED", test, t);
    }

    /**
     * Interface TestListener for JUnit &gt; 3.4.
     * <p>
     * A Test failed.
     * 
     * @param test the test.
     * @param t the assertion that failed.
     */
    public void addFailure(Test test, AssertionFailedError t) {
        this.addFailure(test, (Throwable) t);
    }

    /**
     * Interface TestListener.
     * <p>
     * An error occurred while running the test.
     * 
     * @param test the test.
     * @param t the exception.
     */
    public void addError(Test test, Throwable t) {
        this.formatError("\tCaused an ERROR", test, t);
    }

    /**
     * Forma error.
     * 
     * @param type type
     * @param test test
     * @param t {@link Throwable}
     */
    private void formatError(String type, Test test, Throwable t) {
        synchronized (this.wri) {
            if (test != null) {
                this.endTest(test);
                this.failed.put(test, Boolean.TRUE);
            }

            try {
                this.wri.write(type);
                this.wri.newLine();
                this.wri.write(String.valueOf(t.getMessage()));
                this.wri.newLine();
                String strace = ConsoleTestRunner.getFilteredTrace(t);
                this.wri.write(strace);
                this.wri.newLine();
            } catch (IOException ex) {
                throw new BuildException(ex);
            }
        }
    }

} // PlainJUnitResultFormatter
